package net.ericaro.neodocs;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Specific purpose refactoring request. Explain what to (re)do.
 * 
 * You can specify a kind of refactoring to perform to improve the code. To do
 * this, use the enum {@link Refactoring}.
 * 
 * @author bcantin
 * 
 * @see PleaseRefactor
 */
@Retention(RetentionPolicy.SOURCE)
public @interface PleaseRefactorWith {

	String value() default "";

	/**
	 * @return the kind of refactoring to perform to make the code better.
	 */
	Refactoring refactoring() default Refactoring.OTHER;
}
